Index | Conventions

Get invoice balance

Path: api/v1/accounts/debtors/invoicebalance/{invno}

This endpoint supports the following methods:
GET

Summary: Returns original amount, balance due and currency code of invoice

Response content

AttributeTypeDescription
amountnumberReturns original amount of invoice
balanceDuenumberReturns balance due amount of invoice
currencyCodestringReturns currency code of invoice
invNointegerInvoice number

Example GET

Path: api/v1/accounts/debtors/invoicebalance/1

Response:

This example shows the maximum set of fields the endpoint can return, all populated. A real response only contains the data that applies to that record, so fields that are empty or not relevant are omitted — do not assume every field shown here will be present in every response.

{
    "invNo": 1,
    "amount": 10.0000,
    "balanceDue": 10.0000,
    "currencyCode": "EUR"
}